Upgrade or Downgrade Service License

The Upgrade or Downgrade Service License request enables you to do the following:

■

Upgrade the license type from Direct Routing Essential Plus to Direct Routing Pro.

■

Downgrade the license type from Direct Routing Pro to Direct Routing Essentials Plus

■

Upgrade the license type from OC Essential Plus to OC Pro.

■

Downgrade the license type from OC Pro to OC Essentials Plus.

For both Direct Routing and Operator Connect services, this request secures the connection to the customer tenant M365 platform using the credentials of the App Registration that you created, see Secure Connection using an App Registration . Ensure that you have extracted the Application (Client) ID and the Client Secret value from this App Registration.

For Operator Connect services only, prior to running this request, you must first upgrade the OC Essential license using Upgrade Operator Connect Customer License.

URI

Copy

{{baseUrl}}/api/v3/customer/{umpCustomerGuid}

HTTP Method

PATCH

Request Parameters

Parameter	Type	Description
CustomerGuid	string($uuid)	This id is created in the Live Platform database for the customer tenant when a Live Platform license is applied. If this field is null, a license has not yet been applied to the lead. This value is also obtained in the 'Get Task' response when the customer is created.

Request Body

Parameter

Type

Description

upgradeToLicense

integer

One of the following values:

■

1: Hosted Essentials Plus

■

2: Hosted Pro

■

4: OC Essential Plus

■

5: OC Pro

licenseCount

integer

The number of licensed users to configure for the customer service.

applicationClientId

string

The Application (Client) Id of the App Registration used to secure connection to customer M365 platform (see Create App Registration Manually). Extract this value from App registration on customer tenant Azure portal.

applicationClientSecret

string

The client secret of the App Registration used to secure connection to customer M365 platform (seeCreate App Registration Manually). Extract this value from App registration on customer tenant Azure portal.

Example Request Body

Copy

{
  "customerFullName": "BBOC532",
  "licenseType": 5,
  "licensedUsersCount": 50,
  "applicationClientId": "0fdc8122-e0b5-43ac-8433-54860113710d",
  "applicationClientSecret": "pr18Q~Fk0bpCZdK7dd4jZvZRy8mXeonQPLasEblW"
}

Example Response

Copy

HTTP Responses

■

200 OK

■

400 Bad Request: When the 'upgradetoLicense' parameter is configured with an invalid value:

Copy

{
  "licenseType": 7
}

The following error is displayed:

Copy

"Invalid change for License Type!"

See 'upgradeToLicense' parameters shown above for valid types.